tbDEX SDK Documentation/tbdex.sdk.httpserver.models

Package-level declarations

Types

BalancesApi

interface BalancesApi

Interface representing an API for interacting with TBDex balances.

CallbackError

class CallbackError(val statusCode: <Error class: unknown class>, val details: List<ErrorDetail>) : Exception

Exception class representing an error that can occur during a callback execution.

Callbacks

class Callbacks(var getOfferings: GetOfferingsCallback? = null, var getBalances: GetBalancesCallback? = null, var getExchanges: GetExchangesCallback? = null, var getExchange: GetExchangeCallback? = null, var createExchange: CreateExchangeCallback? = null, var submitOrder: SubmitOrderCallback? = null, var submitClose: SubmitCloseCallback? = null)

Class that houses all callback types for the TBDex HTTP server.

CreateExchangeCallback

typealias CreateExchangeCallback = suspend (<Error class: unknown class>, Rfq, Offering?, String?) -> Unit

ErrorResponse

class ErrorResponse(val errors: List<ErrorDetail>)

Error response

ExchangesApi

interface ExchangesApi

Interface representing an API for interacting with TBDex exchanges and related entities.

FakeBalancesApi

class FakeBalancesApi : BalancesApi

Fake balances api.

FakeExchangesApi

class FakeExchangesApi : ExchangesApi

A fake implementation of the ExchangesApi interface for testing purposes. This class provides mock implementations for various methods.

FakeOfferingsApi

class FakeOfferingsApi : OfferingsApi

A fake implementation of the OfferingsApi interface for testing purposes. This class provides mock implementations for retrieving offering information.

Filter

sealed interface Filter

Interface representing a generic filter for API requests.

GetBalancesCallback

typealias GetBalancesCallback = suspend (<Error class: unknown class>) -> Any

GetExchangeCallback

typealias GetExchangeCallback = suspend (<Error class: unknown class>) -> Any

GetExchangesCallback

typealias GetExchangesCallback = suspend (<Error class: unknown class>, GetExchangesFilter?) -> Any

GetExchangesFilter

class GetExchangesFilter(val exchangeIds: List<String>? = null, val from: String? = null) : Filter

Represents a filter for retrieving exchanges based on specific criteria.

GetOfferingsCallback

typealias GetOfferingsCallback = suspend (<Error class: unknown class>) -> Any

OfferingsApi

interface OfferingsApi

Interface representing an API for interacting with TBDex offerings.

SubmitCloseCallback

typealias SubmitCloseCallback = suspend (<Error class: unknown class>, Close) -> Unit

SubmitOrderCallback

typealias SubmitOrderCallback = suspend (<Error class: unknown class>, Order) -> Unit